Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the SQL API documentation in REST specification #51534

Merged
merged 1 commit into from
Feb 2, 2020
Merged

Conversation

karmi
Copy link
Contributor

@karmi karmi commented Jan 28, 2020

This patch fixes the SQL REST API documentation to conform to the current schema.

@karmi karmi requested a review from costin January 28, 2020 14:10
Copy link
Member

@costin costin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Děkuji! - LGTM

P.S. Not sure what's with the license compliance check.

@karmi
Copy link
Contributor Author

karmi commented Jan 28, 2020

Cu plăcere! :) Not sure about the FOSSA check either, this patch shouldn't introduce any new issues anyway...

I'm not sure what's the merging strategy right now, but it would be nice to merge this patch to 7.x branch as well — do you know what's the preferred way of doing that?

@costin
Copy link
Member

costin commented Jan 28, 2020

I'm not sure either - for large/complicated commits I create a separated PR; for small ones (like this) I simply cherry-pick and push to 7.x after testing locally with a message that refers to the initial commit (so it gets picked by Github as well).

@costin
Copy link
Member

costin commented Jan 30, 2020

@karmi anything preventing this PR from being merged? Is it the license check - I think we can ask infra or simply ignore it.

@karmi
Copy link
Contributor Author

karmi commented Jan 31, 2020

No, sorry, @costin, I did the patch during a week of giving trainings and it got more hectic afterwards. I'll merge today or tomorrow.

@karmi karmi merged commit c8b6a84 into master Feb 2, 2020
karmi added a commit that referenced this pull request Feb 2, 2020
This patch fixes the SQL REST API documentation to conform to the current schema.

(cherry picked from commit c8b6a84)
karmi added a commit that referenced this pull request Feb 2, 2020
* REST: Test: Fix the `accept_enterprise` parameter for Get License API (#51527)

The Get License API specifies the `accept_enterprise` parameter as a `boolean`:

https://github.com/elastic/elasticsearch/blob/0ca5cb8cb636a4be9c36b8e38e565af66abc423b/x-pack/plugin/src/test/resources/rest-api-spec/api/license.get.json#L22-L27

In the test, a `string` is passed however, which makes the test compilation fail in the Go client.

(cherry picked from commit e2a2169)

* Fix the SQL API documentation in REST specification (#51534)

This patch fixes the SQL REST API documentation to conform to the current schema.

(cherry picked from commit c8b6a84)

* Fix the "slices" parameter for the Delete By Query API in the REST specification (#51535)

This patch updates the `type` parameter in the Delete By Query API: according to
[the documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html#docs-delete-by-query-slice),
it can be set to "auto", but the type in the documentation allows only numerical values.

This prevents people from setting the parameter to "auto" eg. in the Go client,
which generates source from the specification, and sets the corresponding Go
type as number.

The patch uses the `|` notation, which we have discussed previously for encoding
a "polymorphic" parameter like this.

Related: elastic/go-elasticsearch#77

* Fix the Enrich API documentation in REST specification (#51528)

This patch fixes the REST API documentation for the Enrich APIs to conform to the current schema.

(cherry picked from commit 59f28f4)
@karmi karmi deleted the rest_spec_fix branch February 2, 2020 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants